home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / bbsutil / pstlg300.zip / POSTLOG.DOC < prev    next >
Text File  |  1989-01-24  |  10KB  |  265 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.                             ┌───────────────────┐
  10.                             │ -*- POSTLOG -*-   │
  11.                             └───────────────────┘
  12.                                 Version: 3.00
  13.  
  14.                                       by
  15.  
  16.                                   Bob Ransom
  17.                                    (c) 1989
  18.                              All Rights Reserved
  19.  
  20.                           Released: January 25, 1989
  21.  
  22.            * * * IMPORTANT NOTE TO USERS OF PREVIOUS VERSIONS * * *
  23.  
  24.           PLEASE! Read this doc or the UPDATE.DOC file contained in
  25.           the Postlog archive.  V3.00 of Postlog represents an
  26.           entire rewrite of the program in Turbo Pascal 5.0
  27.           (previous versions were written in QuickBASIC v4.0b).
  28.           With this rewrite, changes were made to how Postlog stores
  29.           its "control" file, and the new format is NOT compatible
  30.           with the old.  A converter program is included in the
  31.           archive to convert the old style control file to the new
  32.           style.  Please take a moment to read the update for
  33.           complete information.  By the way: if you wonder why I
  34.           rewrote the program in TP, consider that this new version
  35.           is 75% smaller in size, but slightly over 300% faster than
  36.           the QuickBASIC versions!  Definitely worthwhile, I'd say.
  37.  
  38.  
  39.           OVERVIEW --
  40.  
  41.           POSTLOG was conceived and created to help me track
  42.           activity on the message boards (mainly echoes) on my
  43.           QuickBBS system.  I'm carrying about 35 echoes now, which
  44.           is not many by some standards.  Nonetheless, I still found
  45.           it hard to keep track of how many messages were posted to
  46.           each board on *my* system.  This problem was most
  47.           pronounced on the very busy echoes like TECH, DEBATE, and
  48.           everyone's favorite, QUICKBBS. Yes, I could scan the
  49.           SYSTEM.LOG by hand, but that's seriously boring.  Besides,
  50.           I'm lazy.  Enter POSTLOG.
  51.  
  52.  
  53.           GENERAL OPERATIONS --
  54.  
  55.           POSTLOG is meant to be run from the directory that
  56.           contains your QuickBBS SYSTEM.LOG.  If POSTLOG can't find
  57.           your log, it aborts immediately with a little message
  58.           telling you what's missing.  POSTLOG is stupid and only
  59.           searches the current path for the file.
  60.  
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.           POSTLOG v2.00 DOC                          Page 2
  68.  
  69.  
  70.  
  71.  
  72.  
  73.           When it finds the log, it reads and then scans each line
  74.           looking for:
  75.  
  76.               "Message #xxxxx entered on board #y: BoardName"
  77.  
  78.           (It's actually looking for the word "entered" which should
  79.           only occur when a message is written.)  When it finds such
  80.           a line, it takes note of the BoardName then increments the
  81.           message counter for that board by one.
  82.  
  83.           When scanning is complete, POSTLOG writes two files to
  84.           your disk:
  85.  
  86.               POSTLOG.ASC -- A "pretty" ASCII file with the board
  87.                              totals, overall totals, and
  88.                              percentages.  This file is meant to
  89.                              be viewed from within QuickBBS.
  90.  
  91.               POSTLOG.CTL -- An "ugly" ASCII file that stores pretty
  92.                              much the same info as the .ASC file,
  93.                              but in an abbreviated and easier-to-
  94.                              work-with format.  POSTLOG.CTL also
  95.                              stores a "pointer" to help the program
  96.                              tell how far it has processed on
  97.                              any given SYSTEM.LOG.  This file is
  98.                              used by POSTLOG each time it's run.
  99.  
  100.           Both of these files are small so they shouldn't cause you
  101.           any undue headaches in the disk space department.
  102.  
  103.           In its original versions, POSTLOG was meant to be run only
  104.           once per day (actually, once per SYSTEM.LOG).  In versions
  105.           1.10 and later, with the addition of the "pointer" file
  106.           (or now, with the pointer stored within the .CTL file),
  107.           POSTLOG may be run as often as you wish.  Depending on
  108.           what you want, you may wish to run it only once per day
  109.           during regular maintenance then use a batch file to move
  110.           the POSTLOG.ASC file to your textfile directory.  Or you
  111.           may wish to run it after each caller.  It's entirely up to
  112.           you.  (I run it after each caller so the list is always
  113.           up-to-date.)
  114.  
  115.  
  116.           CONVERTING FROM PREVIOUS VERSIONS --
  117.  
  118.           As the format of the POSTLOG.CTL file has been changed,
  119.           v3.00 will puke (promptly) if you try to run it with a
  120.           v2.00 control file present.  Rather than force you to lose
  121.           your old totals, I wrote a little program called
  122.           OLDTONEW.EXE to convert the file.  Run OLDTONEW from the
  123.           directory that contains the POSTLOG.CTL file.  When it's
  124.           finished (it'll only take a few seconds), you may delete
  125.           both the OLDTONEW.EXE file and the old POSTLOG.PTR file.
  126.           The old pointer data has been moved to the new .CTL file,
  127.  
  128.  
  129.  
  130.  
  131.  
  132.  
  133.           POSTLOG v2.00 DOC                          Page 3
  134.  
  135.  
  136.  
  137.  
  138.  
  139.           so the .PTR file is no longer necessary (though leaving it
  140.           there won't hurt anything -- except disk space).
  141.  
  142.  
  143.           OTHER THINGS YOU SHOULD KNOW --
  144.  
  145.           As POSTLOG reads directly from the SYSTEM.LOG (not
  146.           AREAS.BBS or CONFIG.BBS), boards with no activity will NOT
  147.           show up.  Remember, this means activity on YOUR BOARD.
  148.           POSTLOG has no way of knowing how many echo messages
  149.           arrive (the program ELVIS does a real nice job of this) --
  150.           it knows only how many messages were posted on your board.
  151.  
  152.           There is no maximum size for the SYSTEM.LOG.  In versions
  153.           prior to v2.00, the maximum size was billed as 1000 lines
  154.           (though, in reality, POSTLOG would choke long before
  155.           then).  Your log can be 1 line long, 100, 1000, 5000,
  156.           whatever -- it no longer matters (longer logs do take
  157.           longer to process, though.  However, the conversion to TP
  158.           5.0 makes this minimal.)
  159.  
  160.           If Postlog should have any problems opening any of the
  161.           files it needs, it will exit with an errorlevel of 1.
  162.           Under normal operation (no problems), the exit errorlevel
  163.           is 0.  I seriously doubt that this is useful, but it was
  164.           so easy to add that I couldn't resist.
  165.  
  166.           The maximum number of message bases that POSTLOG will
  167.           handle is 200 -- the same as QuickBBS.  If this changes
  168.           with QuickBBS (in version 3 or whatever), I'll change
  169.           POSTLOG to accommodate.  The maximum number of messages
  170.           attributed to any given board is 32,767.  The maximum
  171.           total number of messages entered is either 65,535 or
  172.           2,147,483,647 -- As I sit here and write this I can't
  173.           remember if I classified that variable as a "word" or a
  174.           "longint."  Regardless, I don't think you'll need to worry
  175.           much about that.... :-)
  176.  
  177.           To reset POSTLOG (and start the message count over again)
  178.           simply delete the control file, POSTLOG.CTL.
  179.  
  180.           POSTLOG is pretty quick: On my 10 Mhz XT clone, it loads,
  181.           scans, and totals a 1392 line SYSTEM.LOG containing 180
  182.           entered messages in about 10 seconds.  This is about a
  183.           300% increase in speed over the QuickBASIC version of the
  184.           program.  (Processing the same log with version 2.00 took
  185.           41 seconds.)  Your times may vary; see dealer for details.
  186.           :-)  (See what happens when you live too long in Detroit?)
  187.  
  188.           POSTLOG terminates the output file (POSTLOG.ASC) with a
  189.           "Press [RETURN] to continue:" and a CTRL-A.  This allows
  190.           you to read the file online using a Type 39 menu command.
  191.           Or, if you use